Vcenter Lcm Deployment MigrationUpgrade InitSpec
The Vcenter Lcm Deployment MigrationUpgrade InitSpec schema contains parameters used for initialization of the migration upgrade.
This schema was added in vSphere API 9.0.0.0.
{
"deployment": {
"source_container": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"appliance": {
"name": "string",
"size": "string",
"thin_disk_mode": false,
"disk_size": "string",
"root_password": "string",
"network_settings": {
"ip_family": "string",
"mode": "string",
"ip": "string",
"dns_servers": [
"string"
],
"prefix": 0,
"gateway": "string",
"hostname": "string"
},
"ova_info": {
"location": "string",
"ssl_verify": false,
"ova_checksum": "string",
"ova_checksum_algorithm": "string",
"certificate": "string"
},
"ceip_enabled": false,
"cpu_allocation": {
"reservation": 0,
"allocate": "string"
},
"memory_allocation": {
"reservation": 0,
"allocate": "string"
}
},
"location": {
"esx": {
"connection": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"placement_config": {
"datastore_name": "string",
"network_name": "string",
"resource_pool_path": "string"
}
},
"vcenter": {
"connection": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"placement_config": {
"vm_folder_path": "string",
"resource_pool_path": "string",
"cluster_path": "string",
"host_path": "string",
"datastore_name": "string",
"datastore_cluster_name": "string",
"network_name": "string"
}
}
}
},
"version": "string",
"cancellation_policy": {
"automatic": false,
"method": [
"string"
],
"source_connection": {
"connection_type": "string"
}
},
"source_shutdown_policy": "string",
"repository": {
"address": "string",
"username": "string",
"password": "string"
},
"post_upgrade_configuration_policy": {
"rename_vm_policy": {
"preserve_original_vm_name": false,
"old_vcenter_name": "string"
},
"delete_vm_policy": {
"source_vc": false
}
},
"vcha_spec": {
"passive_node_container": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
},
"witness_node_container": {
"hostname": "string",
"username": "string",
"password": "string",
"https_port": 0,
"ssl_verify": false,
"certificate": "string"
}
}
}Specification to describe the new appliance deployment configuration.
This property was added in vSphere API 9.0.0.0.
Upgrade to vCSA version. The version is part of the metadata for each upgrade/update. It can be retrieved via the pending updates API.
This property was added in vSphere API 9.0.0.0.
Provides option to configure additional cancellation support and to enable automatic cancellation on error of the upgrade process.
This property was added in vSphere API 9.0.0.0.
cancellationPolicy If missing or null then the default support is provided - Vcenter Lcm Deployment MigrationUpgrade CancelType.CLEAN_UP and there is no automatic cancellation on error
Provides the ability to configure when the source vCenter should be shutdown during the upgrade.
For more information see: Vcenter Lcm Deployment MigrationUpgrade SourceShutdownPolicy.
This property was added in vSphere API 9.0.0.0.
If missing or null the source vCenter will be shutdown during the upgrade.
Provides a configuration for a repository containing vCenter deployment packages. Overrides the repository set with PUT /vcenter/lcm/deployment/repository only for the upgrade being initialized.
This property was added in vSphere API 9.0.0.0.
If missing or null the configured Vcenter Lcm Deployment Repository is used.
Provides post upgrade configuration options like source VM name preservation.
This property was added in vSphere API 9.0.0.0.
If missing or null no additional post upgrade configuration will be done
Provides VMware vCenter High Availability (VCHA) related upgrade configuration. Not needed for when VCHA is automatically configured. However, in the cases of VCHA with manual setup, vCenter containers connection information has to be provided in order to recreate Passive and Witness nodes in the same location as before upgrade.
This property was added in vSphere API 9.0.0.0.
If missing or null in manual VCHA setups, the upgrade process disables VCHA on the target machine. It is expected to manually recreate passive and witness nodes and enable back VCHA post-upgrade. In this case pre-upgrade nodes will remain powered off but not deleted; it is recommended to remove these to optimize storage usage. For auto VCHA setups this option will be ignored.